R_PartAddress Tabular View

Parent class containing and linking to information about an entity which is a part of another entity. In this case, it is the address part of a person entity.

Used by:

[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PART" }

Indicates that this is a Part role.

[1..1] [M] addr (AD)

The particular flavour of the address datatype used here is Address streetAddressLine Typed (format 2 in the datatypes description), plus:

Optional Postcode
Optional Address Key
Optional Description
Mandatory Use
Optional Useable period

This means that the address will contain the following components:

Between one and five streetAddressLine elements. Excludes postcode, may be vernacular or PAF-derived. For vernacular addresses, the following formatting convention should normally apply although there may be some exceptions:
- Line 1: premises ID
- Line 2: no. / thoroughfare
- Line 3: locality
- Line 4: post town
- Line 5: county
- Lines 1 or 2 and line 4 should normally be mandatory although there may be some exceptions
A postalCode element to carry a postcode (optional)
An addressKey element to carry a PAF key (optional)
A desc element to carry a free-text description of the nature of the address (e.g. "On holiday") (optional, may only be present for a temporary address, i.e. if the use attribute is "TMP")
The use attribute to denote the type of address. This is restricted to "H" (Home address) within: Advanced Trace Response, Create Initial Record Rejected (Duplicate Found) and RetrievePatientResponse messages. Otherwise the permitted values are "H" (Home address), "TMP" (Temporary address) and "PST" (Postal address) (mandatory)
A useablePeriod element to contain the dates for which the address is / was current as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified. (optional)

NB If this is used within a Retrieval Response, then the following will also be present:

An id attribute to carry the PDS allocated object identifier for the data item (mandatory)

This will be used to control the update semantics when performing updates.

[0..1] subjectOf1

A link to an Observation that this role is the subject of.
This link is mandatory if this CMET is used within the Create Initial Record Request Rejected (Duplicate Found). Otherwise, this link is only present if this CMET is used in response to a query where historic data was returned.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that this is a Subject participation.

[1..1] [R] source (Source)

A link to details of the system that was the source of this information.

[0..1] subjectOf2

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that this is a Subject participation.

[1..1] [R] systemEffectiveDate (SystemEffectiveDate)

A link to details of when this information is / was effective on the system.

Source

Parent class containing details of an observation about a piece of data, specifically the system that was the source of the data.

Used by: PartOfWhole

[1..1] either : SourceIdentified

This class should be used if the source system takes the form of an identifier.

... or ... : SourceCoded

This class should be used if the source system takes the form of a National System code.

SourceIdentified

Parent class containing details of a source system, when it takes the form of an identifier.

Used by: PartOfWhole,Source

[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an Observation act.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:AdministrativeObservationType } ) { Fixed="01" }

Indicates the type of observation. In this case, the observation is that of a source system.

The Coded with Code System datatype flavour is used to carry this information as follows:

The code attribute will contain the value "01" (Source) from the list of codes in the AdministrativeObservationType vocabulary
The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.170"

[1..1] [M] value (II)

The source system. This will be one of:

SDS Accredited System Identifier (ASID)
NHS Directory Services Organisation Code

The Identifier External datatype flavour is used to carry this information as follows:

If it is a SDS Accredited System Identifier (ASID):

The root attribute will contain an OID with the value "1.2.826.0.1285.0.2.0.107"

The extension attribute will contain the SDS Accredited System Identifier

If it is a NHS Directory Services Organisation Code:

The root attribute will contain an OID with the value "1.2.826.0.1285.0.1.10" (SDS Organisation ID)

The extension attribute will contain the NHS Directory Services Organisation Code

SourceCoded

Parent class containing details of a source system, when it takes the form of a National System code.

Used by: PartOfWhole,Source

[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an Observation act.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:AdministrativeObservationType } ) { Fixed="01" }

Indicates the type of observation. In this case, the observation is that of a source system.

The Coded with Code System datatype flavour is used to carry this information as follows:

The code attribute will contain the value "01" (Source) from the list of codes in the AdministrativeObservationType vocabulary
The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.170"

[1..1] [M] value (CV {CNE:NationalSystemCode } )

A code identifying the National System.

The Coded with Code System datatype flavour is used to carry this information as follows:

The code attribute will contain a value from the list of codes in the NationalSystemCode vocabulary

The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.174"

SystemEffectiveDate

Parent class containing details of an observation about a piece of data, specifically the times for which the data is / was effective on the system.

Used by: PartOfWhole

[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an Observation act.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:AdministrativeObservationType } ) { Fixed="02" }

Indicates the type of observation. In this case, the observation is that of a system effective date.

The Coded with Code System datatype flavour is used to carry this information as follows:

The code attribute will contain the value "02" (System effective date) from the list of codes in the AdministrativeObservationType vocabulary
The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.170"

[1..1] [M] value (IVL<TS>)

The system effective dates represented as a range, supplied in the low and high sub-elements. The system effective from date will always be present. The system effective to date is only present for historic data.

For current and future dated data, only the Low attribute will be set. Only returned when history or future data is returned.


COCT_RM000201UK02

PartOfWhole		Parent class containing and linking to information about an entity which is a part of another entity. In this case, it is the address part of a person entity.

	Used by:

[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PART" }		Indicates that this is a Part role.

[1..1] [M] addr (AD)		The particular flavour of the address datatype used here is Address streetAddressLine Typed (format 2 in the datatypes description), plus: Optional Postcode Optional Address Key Optional Description Mandatory Use Optional Useable period This means that the address will contain the following components: Between one and five streetAddressLine elements. Excludes postcode, may be vernacular or PAF-derived. For vernacular addresses, the following formatting convention should normally apply although there may be some exceptions: Line 1: premises ID Line 2: no. / thoroughfare Line 3: locality Line 4: post town Line 5: county Lines 1 or 2 and line 4 should normally be mandatory although there may be some exceptions A postalCode element to carry a postcode (optional) An addressKey element to carry a PAF key (optional) A desc element to carry a free-text description of the nature of the address (e.g. "On holiday") (optional, may only be present for a temporary address, i.e. if the use attribute is "TMP") The use attribute to denote the type of address. This is restricted to "H" (Home address) within: Advanced Trace Response, Create Initial Record Rejected (Duplicate Found) and RetrievePatientResponse messages. Otherwise the permitted values are "H" (Home address), "TMP" (Temporary address) and "PST" (Postal address) (mandatory) A useablePeriod element to contain the dates for which the address is / was current as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified. (optional) NB If this is used within a Retrieval Response, then the following will also be present: An id attribute to carry the PDS allocated object identifier for the data item (mandatory) This will be used to control the update semantics when performing updates.

[0..1] subjectOf1		A link to an Observation that this role is the subject of. This link is mandatory if this CMET is used within the Create Initial Record Request Rejected (Duplicate Found). Otherwise, this link is only present if this CMET is used in response to a query where historic data was returned.


[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }		Indicates that this is a Subject participation.

[1..1] [R] source (Source)		A link to details of the system that was the source of this information.

[0..1] subjectOf2		A link to an Observation that this role is the subject of. This link is mandatory if this CMET is used within the Create Initial Record Request Rejected (Duplicate Found). Otherwise, this link is only present if this CMET is used in response to a query where historic data was returned.


[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }		Indicates that this is a Subject participation.

[1..1] [R] systemEffectiveDate (SystemEffectiveDate)		A link to details of when this information is / was effective on the system.

Source		Parent class containing details of an observation about a piece of data, specifically the system that was the source of the data.

	Used by: PartOfWhole

[1..1] either : SourceIdentified		This class should be used if the source system takes the form of an identifier.

... or ... : SourceCoded		This class should be used if the source system takes the form of a National System code.

SourceIdentified		Parent class containing details of a source system, when it takes the form of an identifier.

	Used by: PartOfWhole,Source

[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }		Indicates that this is an Observation act.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }		Indicates that this is an Event.

[1..1] [M] code (CV {CNE:AdministrativeObservationType } ) { Fixed="01" }		Indicates the type of observation. In this case, the observation is that of a source system. The Coded with Code System datatype flavour is used to carry this information as follows: The code attribute will contain the value "01" (Source) from the list of codes in the AdministrativeObservationType vocabulary The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.170"

[1..1] [M] value (II)		The source system. This will be one of: SDS Accredited System Identifier (ASID) NHS Directory Services Organisation Code The Identifier External datatype flavour is used to carry this information as follows: If it is a SDS Accredited System Identifier (ASID): The root attribute will contain an OID with the value "1.2.826.0.1285.0.2.0.107" The extension attribute will contain the SDS Accredited System Identifier If it is a NHS Directory Services Organisation Code: The root attribute will contain an OID with the value "1.2.826.0.1285.0.1.10" (SDS Organisation ID) The extension attribute will contain the NHS Directory Services Organisation Code

SourceCoded		Parent class containing details of a source system, when it takes the form of a National System code.

	Used by: PartOfWhole,Source

[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }		Indicates that this is an Observation act.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }		Indicates that this is an Event.

[1..1] [M] code (CV {CNE:AdministrativeObservationType } ) { Fixed="01" }		Indicates the type of observation. In this case, the observation is that of a source system. The Coded with Code System datatype flavour is used to carry this information as follows: The code attribute will contain the value "01" (Source) from the list of codes in the AdministrativeObservationType vocabulary The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.170"

[1..1] [M] value (CV {CNE:NationalSystemCode } )		A code identifying the National System. The Coded with Code System datatype flavour is used to carry this information as follows: The code attribute will contain a value from the list of codes in the NationalSystemCode vocabulary The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.174"

SystemEffectiveDate		Parent class containing details of an observation about a piece of data, specifically the times for which the data is / was effective on the system.

	Used by: PartOfWhole

[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }		Indicates that this is an Observation act.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }		Indicates that this is an Event.

[1..1] [M] code (CV {CNE:AdministrativeObservationType } ) { Fixed="02" }		Indicates the type of observation. In this case, the observation is that of a system effective date. The Coded with Code System datatype flavour is used to carry this information as follows: The code attribute will contain the value "02" (System effective date) from the list of codes in the AdministrativeObservationType vocabulary The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.170"

[1..1] [M] value (IVL<TS>)		The system effective dates represented as a range, supplied in the low and high sub-elements. The system effective from date will always be present. The system effective to date is only present for historic data. For current and future dated data, only the Low attribute will be set. Only returned when history or future data is returned.

R_PartAddress - tabular view